Correct stable 2020 01 01 #15761

anat-gilenson · 2021-08-24T07:27:30Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Add a changelog entry for this PR by answering the following questions:

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360:
  Remove Settings definitions (doesn't exist in 2020) and remove Critical enum value in IncidentInfo which doesn't exist.
- Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No refresh required for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

Check this box if any of the following apply to the PR so that label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

…t Severity to a definition.

…have 'Critical' value.

…in Bookmarks.json

openapi-workflow-bot · 2021-08-24T07:27:32Z

Hi, @anat-gilenson Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

openapi-workflow-bot · 2021-08-24T07:27:33Z

[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

openapi-pipeline-app · 2021-08-24T07:27:35Z

Swagger Validation Report

️❌BreakingChange: 7 Errors, 1 Warnings failed [Detail]

Compared Swaggers (Based on Oad v0.9.0)
- current:Microsoft.SecurityInsights/stable/2020-01-01 compared with base:Microsoft.SecurityInsights/stable/2020-01-01

Rule	Message
`❌` 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'SettingsKind' removed or renamed? New: Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json#L522:3 Old: Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json#L522:3
`❌` 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'UebaSettings' removed or renamed? New: Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json#L522:3 Old: Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json#L522:3
`❌` 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'ToggleSettings' removed or renamed? New: Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json#L522:3 Old: Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json#L522:3
`❌` 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'Settings' removed or renamed? New: Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json#L522:3 Old: Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json#L522:3
`❌` 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'Settings' removed or renamed? New: Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json#L1385:3 Old: Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json#L1385:3
`❌` 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'SettingsName' removed or renamed? New: Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json#L1385:3 Old: Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json#L1385:3
`❌` 1019 - RemovedEnumValue	The new version is removing enum value(s) 'Critical' from the old version. New: Microsoft.SecurityInsights/stable/2020-01-01/Bookmarks.json#L341:9 Old: Microsoft.SecurityInsights/stable/2020-01-01/Bookmarks.json#L341:9
⚠️ 1026 - TypeChanged	The new version has a different type 'object' than the previous one ''. New: Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json#L907:5 Old: Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json#L902:5

️⚠️LintDiff: 0 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- securityinsights/resource-manager/readme.md tag:package-2020-01
Linted configuring files (Based on target branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- securityinsights/resource-manager/readme.md tag:package-2020-01

The following errors/warnings exist before current PR submission:

Rule	Message
`❌` R4017 - TopLevelResourcesListBySubscription	The top-level resource 'AlertRule' does not have list by subscription operation, please add it. Location: Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json#L626
`❌` R4017 - TopLevelResourcesListBySubscription	The top-level resource 'AlertRuleTemplate' does not have list by subscription operation, please add it. Location: Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json#L669
`❌` R4017 - TopLevelResourcesListBySubscription	The top-level resource 'Bookmark' does not have list by subscription operation, please add it. Location: Microsoft.SecurityInsights/stable/2020-01-01/Bookmarks.json#L224
`❌` R4017 - TopLevelResourcesListBySubscription	The top-level resource 'DataConnector' does not have list by subscription operation, please add it. Location: Microsoft.SecurityInsights/stable/2020-01-01/DataConnectors.json#L399
`❌` R4017 - TopLevelResourcesListBySubscription	The top-level resource 'Incident' does not have list by subscription operation, please add it. Location: Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json#L481
`❌` R4018 - OperationsApiResponseSchema	The response schema of operations API '/providers/Microsoft.SecurityInsights/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json#L37
⚠️ R3010 - TrackedResourceListByImmediateParent	The child tracked resource, 'comments' with immediate parent 'Incident', must have a list by immediate parent operation. Location: Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json#L538
⚠️ R3017 - GuidUsage	Guid used in model definition 'ClientInfo' for property 'objectId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json#L458
⚠️ R3017 - GuidUsage	Guid used in model definition 'IncidentOwnerInfo' for property 'objectId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json#L668
⚠️ R3017 - GuidUsage	Guid used in model definition 'UserInfo' for property 'objectId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json#L1097
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json#L877
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json#L1050
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json#L1243
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: suppressionEnabled Location: Microsoft.SecurityInsights/stable/2020-01-01/AlertRules.json#L1258

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️[Staging] SDK Track2 Validation: 0 Warnings warning [Detail]

The following tags are being changed in this PR

securityinsights/resource-manager/readme.md#package-2020-01

The following errors/warnings are introduced by current PR:

|:speech_balloon: AutorestCore/Exception|"readme":"securityinsights/resource-manager/readme.md",
"tag":"package-2020-01",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"securityinsights/resource-manager/readme.md",
"tag":"package-2020-01",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ PreCheck/PropertyRedeclarationWarning	"readme":"securityinsights/resource-manager/readme.md", "tag":"package-2020-01", "details":"Schema 'MCASDataConnectorDataTypes' has a property 'alerts' that is already declared the parent schema 'AlertsDataTypeOfDataConnector' but isn't significantly different. The property has been removed from MCASDataConnectorDataTypes"
💬 AutorestCore/Exception	"readme":"securityinsights/resource-manager/readme.md", "tag":"package-2020-01", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"

️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2021-08-24T07:27:35Z